.. _ecmPtmCtl_SetHold:

ecmPtmCtl_SetHold
=================
-----------------


SYNOPSIS
--------


.. code-block:: none

  t_success  ecmPtmCtl_SetHold(
    t_i32  NetID,
    t_i32  PtmMapIndex,
    t_bool  IsHold,
    t_i32  *ErrCode
  )



DESCRIPTION
-----------


- 이 함수는 PtmMapIndex로 지정된 PT-Motion 맵의 Hold 상태를 셋팅하는 함수입니다.



PARAMETER
---------


- NetID : Network 번호

- PtmMapIndex : Hold 상태를 설정하고자 하는 대상 PT-Motion 맵 인덱스.

- IsHold : Hold 상태를 설정합니다.

+-------+----------------------------------------------+
| Value | Meaning                                      |
+=======+==============================================+
| 0     | 해당 PT-Motion 맵의 이송이 중지 됩니다       |
+-------+----------------------------------------------+
| 1     | 해당 PT-Motion 맵의 이송이 다시 재개 됩니다. |
+-------+----------------------------------------------+

- ErrCode : 이 매개 변수를 통하여 현재의 에러 코드를 반환합니다. 단, 이 매개 변수에 NULL을 전달하면 에러 코드를 반환하지 않습니다.




RETURN VALUE
------------


- 이 리턴값은 불 형(Boolean Type) 을 가지고 있습니다.


+-------+--------------------------------------+
| Value | Meaning                              |
+=======+======================================+
| 0     | 함수 수행이 실패하였음을 의미합니다. |
+-------+--------------------------------------+
| 1     | 함수 수행이 성공하였음을 의미합니다. |
+-------+--------------------------------------+


.. seealso::
  :ref:`ecmPtmCtl_Begin EXAMPLE 참고  <ecmPtmCtl_Begin>`